================================================================================================
 CROWN PRODUCT REFERENCE RESOURCE (PRR) API
 Copyright © 2025 – Crown Equipment Corporation
 Version 1.0 – October 2025
================================================================================================

Document Title: Endpoint Key/Value Glossary
Document Updated: 10/08/2025

	This document covers the explanation and usage of the Crown Product Reference Resource (PRR) API.
	This document outlines the structure and semantics of the PRR endpoint's keys and labels, intended to guide data parsing and interpretation.

------------------------------------------------------------------------------------------------
 Contents
------------------------------------------------------------------------------------------------

	001.0 - Key Glossary Table
	002.0 - Javascript Parsing Example


------------------------------------------------------------------------------------------------
 001.0 - Key Glossary Table (widen window for proper layout)
------------------------------------------------------------------------------------------------

	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| Section                         | Key / Label                         | Description                                      | Example                          |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| Top-level[]                     | productBaseCode                     | Internal/base product code.                      | sp-1500                          |
	|                                 | lastPublishedDate                   | Last time the product data was published.        | 2025-07-15T14:32:10Z             |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| productSeries[]                 | seriesId                            | Series identifier.                               | SP 1500                          |
	|                                 | seriesName                          | Series display name.                             | Stockpicker 1500 Series          |
	|                                 | seriesDescription                   | Text description of the series.                  | High-capacity stockpicker        |
	|                                 | seriesImage                         | Series image reference.                          | /content/dam/.../series.jpg      |
	|                                 | productCategory                     | High-level category.                             | Stackers                         |
	|                                 | seriesCategory                      | Subcategory classification.                      | Walkie Stackers                  |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| productDetails[]                | productDetailEnglishFieldId         | Internal field identifier (authoring aid).       | modelNumber                      |
	|                                 | productDetailDisplayLabel           | Localized display label for the detail.          | Model Number                     |
	|                                 | productDetailFieldValue.plaintext   | Detail value (plain text).                       | SP 1500-30                       |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| localizedProductFeature[]       | forkliftTypeDisplayLabel            | Display label for forklift type.                 | Forklift Type                    |
	|                                 | forkliftType                        | Forklift type value.                             | Stackers                         |
	|                                 | powerTypeDisplayLabel               | Display label for power type.                    | Power Type                       |
	|                                 | powerType                           | Power type value.                                | Electric                         |
	|                                 | operatingPositionDisplayLabel       | Display label for operating position.            | Operating Position               |
	|                                 | operatingPosition                   | Operating position value.                        | Walk-behind                      |
	|                                 | applicationsDisplayLabel            | Display label for applications.                  | Applications                     |
	|                                 | applications                        | List of application use-cases.                   | ["Loading","Unloading"]          |
	|                                 | mastTypeDisplayLabel                | Display label for mast type.                     | Mast Type                        |
	|                                 | mastType                            | Supported mast types.                            | ["Two-Stage","Three-Stage"]      |
	|                                 | environmentDisplayLabel             | Display label for environment.                   | Environment                      |
	|                                 | environment                         | Operating environment.                           | Indoor                           |
	|                                 | powerSpecificationDisplayLabel      | Display label for power specification.           | Power Specification              |
	|                                 | powerSpecification                  | Power specification detail.                      | 24V                              |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| productSpecification[]          | specificationEnglishFieldId         | Internal field identifier (authoring aid).       | overallWeight                    |
	|                                 | specificationLabel                  | Localized spec label.                            | Overall Weight                   |
	|                                 | specifcationMeasureImperial         | Imperial measurement/value.                      | 4,500 lb                         |
	|                                 | specifcationMeasureMetric           | Metric measurement/value.                        | 2041 kg                          |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| productResources[]              | resourceLabel                       | Resource type label.                             | Brochure                         |
	|                                 | resourceThumbnailLink               | Optional thumbnail for the resource.             | https://thumb.png                |
	|                                 | resourceLink._publishUrl            | Published URL to the resource.                   | https://brochure.pdf             |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| productImages[]                 | imageCategory                       | Image set category.                              | Beauty                           |
	|                                 | imageThumbnail                      | Thumbnail image for the set.                     | https://thumb.jpg                |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+
	| productImages[].imageVariants[] | imageLabel                          | Variant label (e.g., Desktop/Tablet/Mobile).     | Desktop                          |
	|                                 | imageLink                           | Variant image URL.                               | https://img.jpg                  |
	+---------------------------------+-------------------------------------+--------------------------------------------------+----------------------------------+


------------------------------------------------------------------------------------------------
 002.0 - Javascript Parsing Example
------------------------------------------------------------------------------------------------

	Code Sample:

		// Build lists for product details
		const productDetails = item.productDetails.map(detail => {
		return `<li><span>${detail.productDetailDisplayLabel}:</span> ${detail.productDetailFieldValue.plaintext}</li>`;
		}).join('');


	This portion of the code is creating a List Item <li> that will print out the current item's spec label (productDetailDisplayLabel) and then the corresponding value.
	Using the example information from the glossary table above:

		Code:     <li><span>${detail.productDetailDisplayLabel}:</span> ${detail.productDetailFieldValue.plaintext}</li>

		Relative: <li><span>Model Number:</span> SP 1500-30</li>

		Rendered: • Model Number: SP 1500-30


------------------------------------------------------------------------------------------------
 ~ Thank you for partnering with Crown.
================================================================================================


